home *** CD-ROM | disk | FTP | other *** search
/ Tech Arsenal 1 / Tech Arsenal (Arsenal Computer).ISO / tek-13 / hexedit.zip / XE.HLP < prev   
Text File  |  1991-11-11  |  15KB  |  478 lines
  1. HELP
  2.  
  3.  Help on Help
  4.  
  5.  Once in help (like you are now), the following commands
  6.  are available :
  7.  
  8.  F1 - Help on Help (this screen)
  9.  F2 - An ~index` (keywords) for items in the help file
  10.  F3 - Goto the previous screen
  11.  F5 - Zoom/Unzoom the help screen
  12.  
  13.  Enter - Get help on a highlighted keyword
  14.  ESC   - Exits help
  15.  
  16.  Tab / Shft+Tab - Highlight the next/previous visible
  17.                   keyword
  18.  
  19.  Arrow keys - Scroll the help screen contents left, right,
  20.               up and down
  21.  
  22.  Page Up/Down - Move up and down a page at a time
  23.  
  24.  Home/End - Goto the beginning/end of the help info for
  25.             the current item
  26.  
  27.  
  28.  In the upper left corner of the help screen (in the
  29.  border), you may see a number and possibly one of three
  30.  arrow characters.
  31.  
  32.   The number is the left column, of the help info, you
  33.   are at. If you are at column one, it will not be
  34.   displayed.
  35.  
  36.   The arrow characters indicate if there is more info
  37.   either above or below (or both) your position.
  38.  
  39.  
  40.  A couple of notes on the help file.
  41.  
  42.  1. heXEdit expects the help file (XE.HLP) to be in the
  43.     directory that XE.EXE is in. If it is not, you will
  44.     get an error message when you invoke help.
  45.  
  46.  2. If you modify the help file, make sure your keywords
  47.     are capitalized and start in column one. It will
  48.     probably be easier to just look at the help file that
  49.     came with heXEdit to see how it's done.
  50.  
  51.  3. There is a limit of 75 lines of information per
  52.     keyword.
  53.  
  54.  4. Keyword information begins with it's keyword and
  55.     ends with a slash (#47).
  56.  
  57.  5. To create a keyword in a help screen, precede the
  58.     keyword with a tilde (#126) and end it with a
  59.     back-quote (#96).
  60.  
  61.  6. In case you might be wondering, most of this help file
  62.     was taken straight from the .DOC file.
  63.  
  64. /
  65. INDEX
  66.  
  67.   Index for heXEdit
  68.  
  69.  ~Help` on Help             ~Edit`ing
  70.  ~About`                    ~Goto` offset
  71.  ~View`ing                  ~Load` a new file
  72.  ~ASCII` chart              ~Mark`er stack
  73.  ~Base` conversion          ~Retrieve` position
  74.  ~Clear` marker stack       ~Search`
  75.  ~Colors`                   Search ~again`
  76.  ~Configuration` file
  77.  
  78. /
  79. ABOUT
  80.  
  81.  heXEdit v3.0  ^^  Rob Stuntz
  82.  
  83.  If you have any questions or comments I can be
  84.  reached at one of these spots :
  85.  
  86.  1. GEnie
  87.     address : R.STUNTZ
  88.  
  89.  2. The Chicago Megaphile BBS  (running Spitfire software)
  90.     312-283-4035 directly or via Circuit Net mail
  91.     address : Rob Stuntz
  92.  
  93.  3. and of course the good ole' U.S. Postal Service at
  94.  
  95.     Rob Stuntz
  96.     1747 Crystal Lane   #610
  97.     Mt. Prospect, IL.  60056
  98.  
  99. /
  100. VIEW
  101.  
  102.  Viewing Commands
  103.  
  104.  F1    - ~Help`
  105.  A     - Show ~ASCII` chart
  106.  B     - ~Base` conversion
  107.  C     - Set ~Colors` (color adapters)
  108.  D/H/O - Display offset #'s as Dec/Hex/Oct
  109.  E     - ~Edit` the file
  110.  G     - ~Goto` offset
  111.  L     - ~Load` a new file
  112.  M     - Push position on ~mark`er stack
  113.  N     - Search ~again`
  114.  R     - ~Retrieve` position from marker stack
  115.  S     - ~Search` the file
  116.  Z     - ~Clear` all entries from marker stack
  117.  
  118.  /       - Scroll up/down 1 line
  119.  PgUp/PgDn - Scroll up/down 1 page
  120.  Home/End  - Go to beg/end of file
  121.  ESC/Alt-X - Quit heXEdit
  122.  
  123. /
  124. ASCII
  125.  
  126.    ASCII Chart
  127.  
  128.  ASCII chart commands
  129.  
  130.  Left arrow key  - go back 16 characters
  131.  Right arrow key - go forward 16 characters
  132.  PageUp          - go back 128 characters
  133.  PageDown        - go forward 128 characters
  134.  D               - display numbers in decimal
  135.  H               - display numbers in hexadecimal
  136.  ESC or Enter    - exits ASCII chart
  137.  
  138. /
  139. BASE
  140.  
  141.    Base Convert
  142.  
  143.  Convert a number from either decimal, hexadecimal or
  144.  binary to the other two.
  145.  
  146.  Base convert commands
  147.  
  148.  Up/Down arrow keys - select the base of the input number
  149.  Enter              - convert the number
  150.  ESC                - exit the base convert routine
  151.  
  152.  Using the arrow keys, move the highlight bar to the
  153.  base of the input number and then either 1) hit Enter
  154.  and enter the number or 2) just start typing the
  155.  number. After the number has been converted, hit any
  156.  key to select the base for another conversion or hit
  157.  ESC to exit.
  158.  
  159.  When you enter the number, I only check for validity
  160.  with the first character. If you try to convert an
  161.  invalid number an error message will be displayed. The
  162.  largest number that can be accurately converted is a 32
  163.  bit number. It has a very simple input routine, so
  164.  don't be surprised if you can enter an invalid number.
  165.  The conversion will be incorrect of course. I leave
  166.  it mostly up to you to enter a valid number.
  167.  
  168. /
  169. COLORS
  170.  
  171.    Set Colors
  172.  
  173.  This command will allow you to change the color of just
  174.  about anything. Of course, if you're using a monochrome
  175.  monitor this command will do nothing. You can also save
  176.  a color ~configuration` file if you like, so that XE will
  177.  startup with the colors you like.
  178.  
  179.  I didn't do anything fancy here. Simply select the area
  180.  you want to change the color in by hitting a letter 'A'
  181.  thru 'W' (with the exception of 'S'), or '1-7'. Then
  182.  enter the number corresponding to the color you want.
  183.  
  184.  Color change commands
  185.  
  186.  F1        - get ~help`
  187.  A-W, 1-7  - select area you want to change (except 'S')
  188.  S         - save a configuration file with the currently
  189.              selected colors
  190.  ESC/Enter - exit the color change screen
  191.  
  192.  This command will save a file named 'XE.CFG'
  193.  that defines the colors for XE to use. The file
  194.  is saved in the same place it was found. If
  195.  this is the first time this file has existed,
  196.  it will be saved in the current directory.
  197.  
  198.  If you want the default colors back, simply delete the
  199.  configuration file and the next time you start XE
  200.  you'll have the default colors.
  201.  
  202. /
  203. EDIT
  204.  
  205.    Editing
  206.  
  207.  Begin editing the file at the current position. If the
  208.  file is a READ ONLY file, a short message to that
  209.  affect will appear and you will be returned to the ~view`
  210.  mode. Of course, you could just hit 'L' to bring up the
  211.  ~Load`file box and change the READ ONLY attribute of the
  212.  file with F8. And then go back and edit. But, it might
  213.  be READ ONLY for a reason ...
  214.  
  215.  Edit commands
  216.  
  217.  F1              - get ~help`
  218.  Alt+A           - displays the ~ASCII` chart
  219.  Alt+B           - ~base` number conversion
  220.  
  221.  BackSpace/Left arrow  - move cursor left 1 byte
  222.  Right arrow     - move cursor right 1 byte
  223.  PageUp          - move cursor to first line on page
  224.  PageDown        - move cursor to last line on page
  225.  Home            - move cursor to beginning of line
  226.  End             - move cursor to end of line
  227.  TAB             - toggle cursor position between the
  228.         hexadecimal display and the ASCII display of the
  229.         file. The above editing commands will move the
  230.         cursor within the area the cursor is in.
  231.         You can edit the file making changes in both
  232.         areas at the same time, if so desired.
  233.  
  234.  ESC/Enter       - quit editing. If you made changes
  235.         you will be prompted to save the changes or not.
  236.         Hit 'Y' to save the changes or 'N' to lose the
  237.         changes. Only the portion of the file that is in
  238.         memory is actually saved. So don't worry about
  239.         waiting for a long save if you are editing a
  240.         large file. You are then returned to the View
  241.         mode.
  242.  
  243.  To change a value when in the hexadecimal portion, just
  244.  type in it's new value. The background of the character
  245.  will change, indicating which bytes have been changed.
  246.  Valid values are '00' - 'FF'. Obviously, hitting a key
  247.  like 'P' will do nothing because 'P' is not a valid
  248.  hexadecimal character. A special note, once you change
  249.  the left half of the byte, you must continue and change
  250.  the right half also.
  251.  
  252.  To change a value when in the ASCII portion of the
  253.  display, simply hit the key of the new value. Or,
  254.  hold down the ALT key while typing the ASCII code
  255.  of the character you want, then release the ALT
  256.  key. Using the ALT key in this area, you can
  257.  enter a value from 32-255. Again, the background will
  258.  change indicating a change.
  259.  
  260.  Note - When in edit mode you will be able to change the
  261.  characters after the EOF. It will look like you are
  262.  changing the file but in reality nothing will be
  263.  changed. You cannot increase the size of the file,
  264.  only change what already exists.  (A small price
  265.  to pay for making the coding easier on me!)
  266.  
  267. /
  268. GOTO
  269.  
  270.    Goto offset
  271.  
  272.  You are prompted for an offset to go to. You can enter
  273.  either a decimal number or a hexadecimal number. If you
  274.  hit ESC while entering a number you will be placed back
  275.  in the ~View` mode with no repositioning taking place.
  276.  The BACKSPACE key can be used to edit your entry. If
  277.  you enter an offset that is beyond the End-Of-File
  278.  (or < 0) you will be prompted again for a number.
  279.  
  280.  To enter a decimal number just type in the number, no
  281.  commas, and hit ENTER.
  282.  
  283.  To enter a hexadecimal number, type a '$' as the first
  284.  character and then continue entering the hex number.
  285.  
  286.  Also, if at anytime while entering a number, you enter
  287.  an 'A' through 'F' a '$' will be inserted into your
  288.  number at the beginning and your entry will be taken as
  289.  a hexadecimal number. For example:
  290.  
  291.         Keystroke               Screen
  292.         3                       3
  293.         5                       35
  294.         1                       351
  295.         E                       $351E
  296.         etc ...
  297.  
  298. /
  299. LOAD
  300.  
  301.    Loading files
  302.  
  303.  Loadfile box commands
  304.  
  305.  Up/Down arrows - move highlight bar one file at a time
  306.  PgUp/PgDn      - move a page at a time
  307.  Home/End       - move to beginning/end of file list
  308.  ENTER          - load the highlighted file
  309.  ESC            - exit without loading
  310.  
  311.  
  312.  While using the Loadfile box, you may encounter an
  313.  error, for one reason or another. Generally speaking, you
  314.  will be given one, some or all of the options below :
  315.  
  316.  Option 1 - (A)bort : if you press 'A' XE will abort the
  317.    operation.
  318.  
  319.  Option 2 - (R)etry : press 'R' to retry the operation.
  320.    (Maybe the drive door was opened before you hit <ENTER>)
  321.  
  322.  Option 3 - (Q)uit XE : press 'Q' to quit XE and return to
  323.    the DOS prompt (or wherever it was that you came from).
  324.  
  325.  Option 4 - Any other key : return to the Loadfile box.
  326.  
  327.  
  328.  You can change the attributes of a file simply by hitting
  329.  F5-F8 (providing the file is available; i.e., the disk is
  330.  in the drive etc.) Move the highlight bar to file you
  331.  want to work with and then simply hit one of the follow-
  332.  ing, depending on what you want to do.
  333.  
  334.         F5 - toggles the Archive bit
  335.         F6 - toggles the System bit
  336.         F7 - toggles the Hidden bit
  337.         F8 - toggles the Read_Only bit
  338.  
  339.  If the attribute change was successful you will hear a
  340.  high pitch tone otherwise you will hear a lower tone
  341.  indicating that the attribute could not be changed for
  342.  one reason or another. You should also see the attribute
  343.  change in the Loadfile box.
  344.  
  345.  *** Note *** Be sure you know what affect changing an
  346.  attribute will have on your system. Some programs act on
  347.  the attributes of a file or may even require certain
  348.  attributes to be set.
  349.  
  350. /
  351. MARK
  352.  
  353.    The marker stack
  354.  
  355.  Your current position in the file can be saved and then
  356.  retrieved later on.
  357.  
  358.  Your position is saved on a stack. If the stack is full
  359.  the oldest position will be deleted and the rest of the
  360.  entries will move down the stack to make room for the
  361.  new entry. The maximum number of positions you can save
  362.  is 100. Also, when your position is saved, it's location
  363.  on the stack is reported to you so you can see how full
  364.  the marker stack is.
  365.  
  366.  This command can also be used while ~search`ing. If the
  367.  search string is found, you can hit 'M' to save that
  368.  position on the marker stack and then continue searching.
  369.  
  370. /
  371. AGAIN
  372.  
  373.    Search again
  374.  
  375.  Search again using the last used search string. If
  376.  there is no previous search string, you will be
  377.  prompted, as if you hit 'S', to enter a search string.
  378.  
  379. /
  380. RETRIEVE
  381.  
  382.    Retrieve position
  383.  
  384.  While ~view`ing the file, if you hit this command you
  385.  will be moved to the location specified by the top
  386.  ~mark`er stack entry. Once you have been moved to the new
  387.  location, the entry you retrieved will be deleted
  388.  from the marker stack. If there are no markers on the
  389.  stack, then nothing will happen.
  390.  
  391. /
  392. SEARCH
  393.  
  394.    Searching
  395.  
  396.  Search the file for a byte or text sequence.
  397.  
  398.  You will be prompted for the type of search (B)yte or
  399.  (T)ext.
  400.  
  401.  For a byte sequence, enter the bytes in hexadecimal
  402.  notation then hit Enter.  As with ~edit`ing, you must
  403.  enter a complete byte, for the search to work
  404.  correctly, although I don't check for that here.  You
  405.  can use the backspace key to go back and make
  406.  corrections.  The maximum length for a byte sequence is
  407.  9 bytes. I think that is plenty long enough, even 4
  408.  bytes would probably be enough to find what you're
  409.  looking for. For example, you might see this prompt :
  410.  
  411.         Enter search bytes :
  412.  
  413.  Now you would just hit the numbers that make up the
  414.  bytes you want to search for, like :
  415.  
  416.         D3 45 FF 00 C4 6E
  417.  
  418.  There is no need to enter a space between each byte as
  419.  I do that for you while you're entering your bytes.
  420.  
  421.  For a text sequence, just type in the text to search
  422.  for, no quotes are needed, and hit Enter. The maximum
  423.  length for a text sequence is 25 characters. And a
  424.  change from my earlier versions, the search is now case
  425.  insensitive.
  426.  
  427.  If the search string is found, the display will move to
  428.  that string's location in the file and will be high-
  429.  lighted at the top of the screen. You can now hit any
  430.  key to continue the search, hit 'M' to ~mark` the
  431.  position or hit ESC to stop searching.
  432.  
  433.  Just to make things simple for myself, every search
  434.  starts at the beginning of the file. Even on large
  435.  files, starting at the beginning to find something you
  436.  know is near the end doesn't take very long at all (at
  437.  least not on my 16 Mhz 386sx!)
  438.  
  439. /
  440. CLEAR
  441.  
  442.    Clear marker stack
  443.  
  444.  This command will delete all entries from the marker
  445.  stack. Careful, there is no turning back from the
  446.  results of this command.
  447.  
  448. /
  449. CONFIGURATION
  450.  
  451.    Configuration file
  452.  
  453.  When heXEdit starts it looks for a configuration file
  454.  that defines the colors to be used. The name of the file
  455.  is 'XE.CFG'. XE first looks in the current directory for
  456.  the file. If it doesn't find it there it checks the
  457.  environment for a variable named 'XE' and looks in the
  458.  path specified by that variable. (See your DOS manual
  459.  for an explanation of environment variables). If XE
  460.  doesn't find it there it then looks in the directory
  461.  that XE.EXE is in.
  462.  
  463.  The environment variable 'XE' can be set by using the
  464.  DOS SET command. You should include the full path, just
  465.  so there is no confusion as to what drive the file is
  466.  on. For example :
  467.  
  468.         SET XE=C:\UTIL\
  469.  
  470.  Also, the last back-slash character should be included
  471.  as I just append the filename to the path you specify. If
  472.  you do use an environment variable but XE can't find the
  473.  file there, it will look in the same directory that
  474.  XE.EXE is in. If you don't use the configuration file in
  475.  the first place, XE will use a default set of ~colors`.
  476.  
  477. /
  478.